/*
 *
 * Copyright (c) 2006-2020, Speedment, Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); You may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.speedment.runtime.config.mutator.trait;

import com.speedment.runtime.config.Document;
import com.speedment.runtime.config.mutator.DocumentMutator;
import com.speedment.runtime.config.trait.HasDecimalDigits;
import com.speedment.runtime.config.trait.HasDecimalDigitsUtil;

/**
 * Trait for {@link DocumentMutator} that have a
 * {@link HasDecimalDigits#getDecimalDigits() decimal digits} property.
 *
 * @param <DOC>  the primary interface for this document type
 *
 * @author Emil Forslund
 * @since  3.1.10
 */
public interface HasDecimalDigitsMutator<DOC extends Document>
        extends DocumentMutator<DOC>{

    /**
     * Mutates the {@link HasDecimalDigits#getDecimalDigits() decimal digits} of
     * the underlying document.
     *
     * @param digits  the new decimal digits count (or {@code null}).
     */
    default void setDecimalDigits(Integer digits) {
        put(HasDecimalDigitsUtil.DECIMAL_DIGITS, digits);
    }
}
